Add Javascript Types w/JSDoc #3577
Open
+1,284
−23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshistoast
changed the title
global.js
|
will be adding more over next week if I have time |
|
It would be very handy to have these in all JS files, not just Global. |
That's the plan |
|
Learning so much about JSDoc, and how much I dislike certain approaches to JS things in this codebase |
|
Unfortunate with how many conditional class definitions there are, references to the types are unresolved when definitions are nested in a conditional. Might be a good way to prevent defining classes multiple times on a page without wrapping the whole thing in a conditional 🤔 |
|
Ready for review, but not ready for merge. |
Should be spelled as `setQuantityBoundaries`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary:
Add JSDoc documentation to javascript functions and classes where applicable.
Why are these changes introduced?
JSDoc is the nest best thing to native JS types. Typing our functions means better understanding of the parameters required and what gets returned without needing to crawl the codebase.
What approach did you take?
Classes, and functions with parameters and returns get JSDoc comments.
Other considerations
Decision log
Visual impact on existing themes
No visual impact.
Testing steps/scenarios
Demo links
Checklist